<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>DRV_SDSPI_Initialize Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00471.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00122.html" target="topic">SD Card (SPI) Driver Library</a> &gt; <a href="00123.html" target="topic">Library Interface</a> &gt; a) System Functions &gt; <a href="00471.html" target="topic">DRV_SDSPI_Initialize Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00123.html" target="topic">Previous</a> | <a href="00123.html" target="topic">Up</a> | <a href="00476.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SDSPI_Initialize@SYS_MODULE_INDEX@SYS_MODULE_INIT * const Topic Title: DRV_SDSPI_Initialize Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
DRV_SDSPI_Initialize Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This routine initializes the SD Card driver, making it ready for clients to open and use the driver.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100"><a href="01189.html" target="topic">SYS_MODULE_OBJ</a> <strong><span style="color: #000000">DRV_SDSPI_Initialize</span></strong>(
    <strong><span style="color: #000080">const</span></strong> <a href="01183.html" target="topic">SYS_MODULE_INDEX</a> <strong><span style="color: #000000">drvIndex</span></strong>, 
    <strong><span style="color: #000080">const</span></strong> <a href="01184.html" target="topic">SYS_MODULE_INIT</a> * <strong><span style="color: #000080">const</span></strong> <strong><span style="color: #000000">init</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
None.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
drvIndex&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Index for the driver instance to be initialized<br>&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
init&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Pointer to a data structure containing any data necessary to initialize the driver.&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
If successful, returns a valid handle to a driver object. Otherwise, it returns <a href="01190.html" target="topic">SYS_MODULE_OBJ_INVALID</a>.</p></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
This routine must be called before any other SD Card routine is called.&nbsp;</p>
<p class="Element10">
This routine should only be called once during system initialization.&nbsp;</p>
<p class="Element10">
The system must use <a href="00476.html" target="topic">DRV_SDSPI_Status</a> to find out when the driver is in the ready state.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12">DRV_SDSPI_INIT      drvSDSPI0InitData;
<a href="01189.html" target="topic">SYS_MODULE_OBJ</a>      objectHandle;

DRV_SDSPI_PLIB_INTERFACE drvSDSPI0PlibAPI = {
    <i><span style="color: #008000">// SPI PLIB WriteRead function</span></i>
    .writeRead = (DRV_SDSPI_WRITEREAD)SPI0_WriteRead,
    <i><span style="color: #008000">// SPI PLIB Write function</span></i>
    .write = (DRV_SDSPI_WRITE)SPI0_Write,
    <i><span style="color: #008000">// SPI PLIB Read function</span></i>
    .read = (DRV_SDSPI_READ)SPI0_Read,
    <i><span style="color: #008000">// SPI PLIB Transfer Status function</span></i>
    .isBusy = (DRV_SDSPI_IS_BUSY)SPI0_IsBusy,
    <i><span style="color: #008000">// SPI PLIB Transfer Setup function</span></i>
    .transferSetup = (DRV_SDSPI_SETUP)SPI0_TransferSetup,
    <i><span style="color: #008000">// SPI PLIB Callback Register</span></i>
    .callbackRegister = (DRV_SDSPI_CALLBACK_REGISTER)SPI0_CallbackRegister,
};

DRV_SDSPI_INIT drvSDSPI0InitData = {
    <i><span style="color: #008000">// SD Card SPI PLIB API interface</span></i>
    .spiPlib            = &amp;drvSDSPI0PlibAPI,
    .remapDataBits = drvSDSPI0remapDataBits,
    .remapClockPolarity = drvSDSPI0remapClockPolarity,
    .remapClockPhase = drvSDSPI0remapClockPhase,
    <i><span style="color: #008000">// SDSPI Number of clients</span></i>
    .numClients         = DRV_SDSPI_CLIENTS_NUMBER_IDX0,
    <i><span style="color: #008000">// SDSPI Client Objects Pool</span></i>
    .clientObjPool      = (uintptr_t)&amp;drvSDSPI0ClientObjPool[0],
    .chipSelectPin      = DRV_SDSPI_CHIP_SELECT_PIN_IDX0,
    .SDSPISpeedHz      = DRV_SDSPI_SPEED_HZ_IDX0,
    .writeProtectPin    = SYS_PORT_PIN_NONE,
    .isFsEnabled   = DRV_SDSPI_REGISTER_WITH_FS_IDX0,
    <i><span style="color: #008000">// DMA Channel for Transmit</span></i>
    .txDMAChannel = DRV_SDSPI_XMIT_DMA_CH_IDX0,
    <i><span style="color: #008000">// DMA Channel for Receive</span></i>
    .rxDMAChannel  = DRV_SDSPI_RCV_DMA_CH_IDX0,
    <i><span style="color: #008000">// SPI Transmit Register</span></i>
    .txAddress = (<strong><span style="color: #000080">void</span></strong> *)&amp;(SPI0_REGS-&gt;SPI_TDR),
    <i><span style="color: #008000">// SPI Receive Register</span></i>
    .rxAddress  = (<strong><span style="color: #000080">void</span></strong> *)&amp;(SPI0_REGS-&gt;SPI_RDR),
};

objectHandle = DRV_SDSPI_Initialize(DRV_SDSPI_INDEX_0, (<a href="01184.html" target="topic">SYS_MODULE_INIT</a> *)&amp;drvSDSPI0InitData);
<strong><span style="color: #000080">if</span></strong> (objectHandle == <a href="01190.html" target="topic">SYS_MODULE_OBJ_INVALID</a>)
{
    <i><span style="color: #008000">// Handle error</span></i>
}</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00007.html" target="topic">Driver Libraries Help</a> &gt; <a href="00122.html" target="topic">SD Card (SPI) Driver Library</a> &gt; <a href="00123.html" target="topic">Library Interface</a> &gt; a) System Functions &gt; <a href="00471.html" target="topic">DRV_SDSPI_Initialize Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00123.html" target="topic">Previous</a> | <a href="00123.html" target="topic">Up</a> | <a href="00476.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: DRV_SDSPI_Initialize@SYS_MODULE_INDEX@SYS_MODULE_INIT * const Topic Title: DRV_SDSPI_Initialize Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>